WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
AMQP Ticket Registry
CAS can be enabled with a variety of messaging systems in order to distribute and share ticket data: from simplified use of the AMQP API to a complete infrastructure to receive messages asynchronously.
This registry is very much an extension of the default ticket registry. The difference is that ticket operations applied to the registry are broadcasted using a messaging queue to other listening CAS nodes on the queue. Each node keeps copies of ticket state on its own and only instructs others to keep their copy accurate by broadcasting messages and data associated with each. Each message and ticket registry instance running inside a CAS node in the cluster is tagged with a unique identifier in order to avoid endless looping behavior and recursive needless inbound operations.
The broadcast and the message queue is backed by the the Advanced Message Queuing Protocol (AMQP) protocol. This is a platform-neutral, wire-level protocol for message-oriented middleware. The implementation of this protocol is backed by RabbitMQ. This is a lightweight, reliable, scalable, and portable message broker based on the AMQP protocol. CAS uses RabbitMQ to communicate through the AMQP protocol.
Support is enabled by including the following dependency in the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-amqp-ticket-registry</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-amqp-ticket-registry:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-amqp-ticket-registry"
}
CAS Configuration
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Third Party
- Notes
cas.ticket.registry.amqp.crypto.encryption.key=
The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting. |
cas.ticket.registry.amqp.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting. |
cas.ticket.registry.amqp.crypto.alg=AES
The signing/encryption algorithm to use. |
cas.ticket.registry.amqp.crypto.enabled=true
Whether crypto operations are enabled. |
cas.ticket.registry.amqp.crypto.encryption.key-size=16
Encryption key size. |
cas.ticket.registry.amqp.crypto.signing.key-size=512
The signing key size. |
cas.ticket.registry.amqp.queue-identifier=
Identifier for this CAS server node that tags the sender/receiver in the queue and avoid processing of inbound calls. If left blank, an identifier is generated automatically and kept in memory. |
spring.rabbitmq.address-shuffle-mode=none
Mode used to shuffle configured addresses. |
spring.rabbitmq.addresses=
Comma-separated list of addresses to which the client should connect. When set, the host and port are ignored. |
spring.rabbitmq.cache.channel.checkout-timeout=
Duration to wait to obtain a channel if the cache size has been reached. If 0, always create a new channel. |
spring.rabbitmq.cache.channel.size=
Number of channels to retain in the cache. When "check-timeout" > 0, max channels per connection. |
spring.rabbitmq.cache.connection.mode=channel
Connection factory cache mode. |
spring.rabbitmq.cache.connection.size=
Number of connections to cache. Only applies when mode is CONNECTION. |
spring.rabbitmq.channel-rpc-timeout=10m
Continuation timeout for RPC calls in channels. Set it to zero to wait forever. |
spring.rabbitmq.connection-timeout=
Connection timeout. Set it to zero to wait forever. |
spring.rabbitmq.dynamic=true
Whether to create an AmqpAdmin bean. |
spring.rabbitmq.host=localhost
RabbitMQ host. Ignored if an address is set. |
spring.rabbitmq.listener.direct.acknowledge-mode=
Acknowledge mode of container. |
spring.rabbitmq.listener.direct.auto-startup=true
Whether to start the container automatically on startup. |
spring.rabbitmq.listener.direct.consumers-per-queue=
Number of consumers per queue. |
spring.rabbitmq.listener.direct.de-batching-enabled=true
Whether the container should present batched messages as discrete messages or call the listener with the batch. |
spring.rabbitmq.listener.direct.default-requeue-rejected=
Whether rejected deliveries are re-queued by default. |
spring.rabbitmq.listener.direct.idle-event-interval=
How often idle container events should be published. |
spring.rabbitmq.listener.direct.missing-queues-fatal=false
Whether to fail if the queues declared by the container are not available on the broker. |
spring.rabbitmq.listener.direct.prefetch=
Maximum number of unacknowledged messages that can be outstanding at each consumer. |
spring.rabbitmq.listener.direct.retry.enabled=false
Whether publishing retries are enabled. |
spring.rabbitmq.listener.direct.retry.initial-interval=1000ms
Duration between the first and second attempt to deliver a message. |
spring.rabbitmq.listener.direct.retry.max-attempts=3
Maximum number of attempts to deliver a message. |
spring.rabbitmq.listener.direct.retry.max-interval=10000ms
Maximum duration between attempts. |
spring.rabbitmq.listener.direct.retry.multiplier=1
Multiplier to apply to the previous retry interval. |
spring.rabbitmq.listener.direct.retry.stateless=true
Whether retries are stateless or stateful. |
spring.rabbitmq.listener.simple.acknowledge-mode=
Acknowledge mode of container. |
spring.rabbitmq.listener.simple.auto-startup=true
Whether to start the container automatically on startup. |
spring.rabbitmq.listener.simple.batch-size=
Batch size, expressed as the number of physical messages, to be used by the container. |
spring.rabbitmq.listener.simple.concurrency=
Minimum number of listener invoker threads. |
spring.rabbitmq.listener.simple.consumer-batch-enabled=false
Whether the container creates a batch of messages based on the 'receive-timeout' and 'batch-size'. Coerces 'de-batching-enabled' to true to include the contents of a producer created batch in the batch as discrete records. |
spring.rabbitmq.listener.simple.de-batching-enabled=true
Whether the container should present batched messages as discrete messages or call the listener with the batch. |
spring.rabbitmq.listener.simple.default-requeue-rejected=
Whether rejected deliveries are re-queued by default. |
spring.rabbitmq.listener.simple.idle-event-interval=
How often idle container events should be published. |
spring.rabbitmq.listener.simple.max-concurrency=
Maximum number of listener invoker threads. |
spring.rabbitmq.listener.simple.missing-queues-fatal=true
Whether to fail if the queues declared by the container are not available on the broker and/or whether to stop the container if one or more queues are deleted at runtime. |
spring.rabbitmq.listener.simple.prefetch=
Maximum number of unacknowledged messages that can be outstanding at each consumer. |
spring.rabbitmq.listener.simple.retry.enabled=false
Whether publishing retries are enabled. |
spring.rabbitmq.listener.simple.retry.initial-interval=1000ms
Duration between the first and second attempt to deliver a message. |
spring.rabbitmq.listener.simple.retry.max-attempts=3
Maximum number of attempts to deliver a message. |
spring.rabbitmq.listener.simple.retry.max-interval=10000ms
Maximum duration between attempts. |
spring.rabbitmq.listener.simple.retry.multiplier=1
Multiplier to apply to the previous retry interval. |
spring.rabbitmq.listener.simple.retry.stateless=true
Whether retries are stateless or stateful. |
spring.rabbitmq.listener.simple.transaction-size=
Deprecation status is |
spring.rabbitmq.listener.stream.auto-startup=true
Whether to start the container automatically on startup. |
spring.rabbitmq.listener.stream.native-listener=false
Whether the container will support listeners that consume native stream messages instead of Spring AMQP messages. |
spring.rabbitmq.listener.type=simple
Listener container type. |
spring.rabbitmq.password=guest
Login to authenticate against the broker. |
spring.rabbitmq.port=
RabbitMQ port. Ignored if an address is set. Default to 5672, or 5671 if SSL is enabled. |
spring.rabbitmq.publisher-confirm-type=
Type of publisher confirms to use. |
spring.rabbitmq.publisher-confirms=
Deprecation status is |
spring.rabbitmq.publisher-returns=false
Whether to enable publisher returns. |
spring.rabbitmq.requested-channel-max=2047
Number of channels per connection requested by the client. Use 0 for unlimited. |
spring.rabbitmq.requested-heartbeat=
Requested heartbeat timeout; zero for none. If a duration suffix is not specified, seconds will be used. |
spring.rabbitmq.ssl.algorithm=
SSL algorithm to use. By default, configured by the Rabbit client library. |
spring.rabbitmq.ssl.enabled=
Whether to enable SSL support. Determined automatically if an address is provided with the protocol (amqp:// vs. amqps://). |
spring.rabbitmq.ssl.key-store=
Path to the key store that holds the SSL certificate. |
spring.rabbitmq.ssl.key-store-algorithm=SunX509
Key store algorithm. |
spring.rabbitmq.ssl.key-store-password=
Password used to access the key store. |
spring.rabbitmq.ssl.key-store-type=PKCS12
Key store type. |
spring.rabbitmq.ssl.trust-store=
Trust store that holds SSL certificates. |
spring.rabbitmq.ssl.trust-store-algorithm=SunX509
Trust store algorithm. |
spring.rabbitmq.ssl.trust-store-password=
Password used to access the trust store. |
spring.rabbitmq.ssl.trust-store-type=JKS
Trust store type. |
spring.rabbitmq.ssl.validate-server-certificate=true
Whether to enable server side certificate validation. |
spring.rabbitmq.ssl.verify-hostname=true
Whether to enable hostname verification. |
spring.rabbitmq.stream.host=localhost
Host of a RabbitMQ instance with the Stream plugin enabled. |
spring.rabbitmq.stream.name=
Name of the stream. |
spring.rabbitmq.stream.password=
Login password to authenticate to the broker. When not set spring.rabbitmq.password is used. |
spring.rabbitmq.stream.port=
Stream port of a RabbitMQ instance with the Stream plugin enabled. |
spring.rabbitmq.stream.username=
Login user to authenticate to the broker. When not set, spring.rabbitmq.username is used. |
spring.rabbitmq.template.default-receive-queue=
Name of the default queue to receive messages from when none is specified explicitly. |
spring.rabbitmq.template.exchange=
Name of the default exchange to use for send operations. |
spring.rabbitmq.template.mandatory=
Whether to enable mandatory messages. |
spring.rabbitmq.template.queue=
Deprecation status is |
spring.rabbitmq.template.receive-timeout=
Timeout for receive() operations. |
spring.rabbitmq.template.reply-timeout=
Timeout for sendAndReceive() operations. |
spring.rabbitmq.template.retry.enabled=false
Whether publishing retries are enabled. |
spring.rabbitmq.template.retry.initial-interval=1000ms
Duration between the first and second attempt to deliver a message. |
spring.rabbitmq.template.retry.max-attempts=3
Maximum number of attempts to deliver a message. |
spring.rabbitmq.template.retry.max-interval=10000ms
Maximum duration between attempts. |
spring.rabbitmq.template.retry.multiplier=1
Multiplier to apply to the previous retry interval. |
spring.rabbitmq.template.routing-key=
Value of a default routing key to use for send operations. |
spring.rabbitmq.username=guest
Login user to authenticate to the broker. |
spring.rabbitmq.virtual-host=
Virtual host to use when connecting to the broker. |
cas.ticket.registry.amqp.crypto.encryption.key=
The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting. |
cas.ticket.registry.amqp.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting. |
cas.ticket.registry.amqp.crypto.alg=AES
The signing/encryption algorithm to use. |
cas.ticket.registry.amqp.crypto.enabled=true
Whether crypto operations are enabled. |
cas.ticket.registry.amqp.crypto.encryption.key-size=16
Encryption key size. |
cas.ticket.registry.amqp.crypto.signing.key-size=512
The signing key size. |
This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.
Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:
1
2
wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]
The outcome would be similar to:
1
2
3
4
5
{
"kty": "oct",
"kid": "...",
"k": "..."
}
The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via
the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a
specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be
recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled
via Configuration Metadata and property migrations applied automatically on
startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Actuator Endpoints
The following endpoints are provided by CAS:
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
cas.monitor.endpoints.jdbc.password-encoder.encoding-algorithm=
The encoding algorithm to use such as |
cas.monitor.endpoints.jdbc.password-encoder.type=NONE
Define the password encoder type to use. Type may be specified as blank or
|
cas.monitor.endpoints.jdbc.driver-class=org.hsqldb.jdbcDriver
The JDBC driver used to connect to the database. |
cas.monitor.endpoints.jdbc.password=
The database connection password. |
cas.monitor.endpoints.jdbc.url=jdbc:hsqldb:mem:cas-hsql-database
The database connection URL. This setting supports the Spring Expression Language. |
cas.monitor.endpoints.jdbc.user=sa
The database user. The database user must have sufficient permissions to be able to handle schema changes and updates, when needed. |
cas.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is |
cas.monitor.endpoints.jdbc.password-encoder.hash-length=16
When used by |
cas.monitor.endpoints.jdbc.password-encoder.secret=
Secret to use with |
cas.monitor.endpoints.jdbc.password-encoder.strength=16
Strength or number of iterations to use for password hashing. Usually relevant when dealing with |
cas.monitor.endpoints.jdbc.autocommit=false
The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction. |
cas.monitor.endpoints.jdbc.batch-size=100
A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30. |
cas.monitor.endpoints.jdbc.data-source-name=
Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is. |
cas.monitor.endpoints.jdbc.ddl-auto=update
Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to
create-drop will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. validate or none settings are likely the only safe options for production use. For more info, see this.
|
cas.monitor.endpoints.jdbc.default-catalog=
Qualifies unqualified table names with the given catalog in generated SQL. |
cas.monitor.endpoints.jdbc.default-schema=
Qualify unqualified table names with the given schema/tablespace in generated SQL. |
cas.monitor.endpoints.jdbc.dialect=org.hibernate.dialect.HSQLDialect
The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML. |
cas.monitor.endpoints.jdbc.fail-fast-timeout=1
Set the pool initialization failure timeout.
connectionTimeout or validationTimeout; they will be honored before this timeout is applied. The default value is one millisecond.
|
cas.monitor.endpoints.jdbc.fetch-size=100
Used to specify number of rows to be fetched in a select query. |
cas.monitor.endpoints.jdbc.generate-statistics=false
Allow hibernate to generate query statistics. |
cas.monitor.endpoints.jdbc.health-query=
The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 |
cas.monitor.endpoints.jdbc.idle-timeout=PT10M
Controls the maximum amount of time that a connection is allowed to sit idle in the pool. This settings supports the
|
cas.monitor.endpoints.jdbc.isolate-internal-queries=false
This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction. Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if#autocommit is disabled.
|
cas.monitor.endpoints.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED
Defines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition |
cas.monitor.endpoints.jdbc.leak-threshold=6000
Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. |
cas.monitor.endpoints.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy
Fully-qualified name of the class that can control the physical naming strategy of hibernate. |
cas.monitor.endpoints.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED
Defines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition |
cas.monitor.endpoints.jdbc.properties=
Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs. |
cas.monitor.endpoints.jdbc.query=
Query to execute in order to authenticate users via JDBC. Example: |
cas.monitor.endpoints.jdbc.read-only=false
Configures the Connections to be added to the pool as read-only Connections. |
cas.monitor.endpoints.jdbc.role-prefix=
Prefix to add to the role. |
cas.monitor.endpoints.jdbc.pool.keep-alive-time=0
This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature. This settings supports the
|
cas.monitor.endpoints.jdbc.pool.max-size=18
Controls the maximum number of connections to keep in the pool, including both idle and in-use connections. |
cas.monitor.endpoints.jdbc.pool.max-wait=PT2S
Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. This settings supports the
|
cas.monitor.endpoints.jdbc.pool.maximum-lifetime=PT10M
This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. This settings supports the
|
cas.monitor.endpoints.jdbc.pool.min-size=6
Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections. |
cas.monitor.endpoints.jdbc.pool.name=
Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration. |
cas.monitor.endpoints.jdbc.pool.suspension=false
Whether or not pool suspension is allowed. There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it. |
cas.monitor.endpoints.jdbc.pool.timeout-millis=1000
The maximum number of milliseconds that the pool will wait for a connection to be validated as alive. |
Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.
cas.jdbc.case-insensitive=false
When choosing physical table names, determine whether names should be considered case-insensitive. |
cas.jdbc.gen-ddl=true
Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables. |
cas.jdbc.physical-table-names=
Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default. |
cas.jdbc.show-sql=false
Whether SQL queries should be displayed in the console/logs. |
If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
package org.example.cas;
import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;
public class MyEncoder extends AbstractPasswordEncoder {
@Override
protected byte[] encode(CharSequence rawPassword, byte[] salt) {
return ...
}
}
If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import java.util.*
byte[] run(final Object... args) {
def rawPassword = args[0]
def generatedSalt = args[1]
def logger = args[2]
def casApplicationContext = args[3]
logger.debug("Encoding password...")
return ...
}
Boolean matches(final Object... args) {
def rawPassword = args[0]
def encodedPassword = args[1]
def logger = args[2]
def casApplicationContext = args[3]
logger.debug("Does match or not ?");
return ...
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
cas.monitor.endpoints.ldap.base-dn=
Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: |
cas.monitor.endpoints.ldap.bind-credential=
The bind credential to use when connecting to LDAP. |
cas.monitor.endpoints.ldap.bind-dn=
The bind DN to use when connecting to LDAP. LDAP connection configuration injected into the LDAP connection pool can be initialized with the following parameters:
|
cas.monitor.endpoints.ldap.ldap-url=
The LDAP url to the server. More than one may be specified, separated by space and/or comma. |
cas.monitor.endpoints.ldap.search-filter=
User filter to use for searching. Syntax is file:/path/to/GroovyScript.groovy to fully build the final filter template dynamically.
|
cas.monitor.endpoints.ldap.type=AUTHENTICATED
The authentication type.
|
cas.monitor.endpoints.ldap.allow-multiple-dns=false
Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result. |
cas.monitor.endpoints.ldap.allow-multiple-entries=false
Set if multiple Entries are allowed. |
cas.monitor.endpoints.ldap.binary-attributes=
Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver. |
cas.monitor.endpoints.ldap.block-wait-time=PT3S
The length of time the pool will block. By default the pool will block indefinitely and there is no guarantee that waiting threads will be serviced in the order in which they made their request. This option should be used with a blocking connection pool when you need to control the exact number of connections that can be created This settings supports the
|
cas.monitor.endpoints.ldap.connect-timeout=PT5S
Sets the maximum amount of time that connects will block. This settings supports the
|
cas.monitor.endpoints.ldap.connection-strategy=
If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
|
cas.monitor.endpoints.ldap.deref-aliases=
Define how aliases are de-referenced. Accepted values are:
|
cas.monitor.endpoints.ldap.disable-pooling=false
Whether to use a pooled connection factory in components. |
cas.monitor.endpoints.ldap.dn-format=
Specify the dn format accepted by the AD authenticator, etc. Example format might be |
cas.monitor.endpoints.ldap.enhance-with-entry-resolver=true
Whether specific search entry resolvers need to be set on the authenticator, or the default should be used. |
cas.monitor.endpoints.ldap.fail-fast=true
Attempt to populate the connection pool early on startup and fail quickly if something goes wrong. |
cas.monitor.endpoints.ldap.follow-referrals=true
Set if search referrals should be followed. |
cas.monitor.endpoints.ldap.hostname-verifier=DEFAULT
Hostname verification options. Available values are as follows:
|
cas.monitor.endpoints.ldap.idle-time=PT10M
Removes connections from the pool based on how long they have been idle in the available queue. Prunes connections that have been idle for more than the indicated amount. This settings supports the
|
cas.monitor.endpoints.ldap.keystore=
Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server. This setting supports the Spring Expression Language. |
cas.monitor.endpoints.ldap.keystore-password=
Keystore password. This setting supports the Spring Expression Language. |
cas.monitor.endpoints.ldap.keystore-type=
The type of keystore. |
cas.monitor.endpoints.ldap.max-pool-size=10
Maximum LDAP connection pool size which the pool can use to grow. |
cas.monitor.endpoints.ldap.min-pool-size=3
Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to |
cas.monitor.endpoints.ldap.name=
Name of the LDAP handler. |
cas.monitor.endpoints.ldap.page-size=0
Request that the server return results in batches of a specific size. See RFC 2696. This control is often used to work around server result size limits. A negative/zero value disables paged requests. |
cas.monitor.endpoints.ldap.pool-passivator=BIND
You may receive unexpected LDAP failures, when CAS is configured to authenticate using
|
cas.monitor.endpoints.ldap.principal-attribute-password=
If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it. For the anonymous authentication type, if principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it. |
cas.monitor.endpoints.ldap.prune-period=PT2H
Removes connections from the pool based on how long they have been idle in the available queue. Run the pruning process at the indicated interval. This settings supports the
|
cas.monitor.endpoints.ldap.resolve-from-attribute=
If this attribute is set, the value found in the first attribute value will be used in place of the DN. |
cas.monitor.endpoints.ldap.response-timeout=PT5S
Duration of time to wait for responses. This settings supports the
|
cas.monitor.endpoints.ldap.sasl-authorization-id=
SASL authorization id. |
cas.monitor.endpoints.ldap.sasl-mechanism=
The SASL mechanism. |
cas.monitor.endpoints.ldap.sasl-mutual-auth=
SASL mutual auth is enabled? |
cas.monitor.endpoints.ldap.sasl-quality-of-protection=
SASL quality of protected. |
cas.monitor.endpoints.ldap.sasl-realm=
The SASL realm. |
cas.monitor.endpoints.ldap.sasl-security-strength=
SASL security strength. |
cas.monitor.endpoints.ldap.search-entry-handlers=
Search handlers. |
cas.monitor.endpoints.ldap.subtree-search=true
Whether subtree searching is allowed. |
cas.monitor.endpoints.ldap.trust-certificates=
Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used. |
cas.monitor.endpoints.ldap.trust-manager=
Trust Manager options. Trust managers are responsible for managing the trust material that is used when making LDAP trust decisions, and for deciding whether credentials presented by a peer should be accepted. Accepted values are: *
|
cas.monitor.endpoints.ldap.trust-store=
Path to the keystore used to determine which certificates or certificate authorities should be trusted. Used when connecting to an LDAP server via LDAPS or startTLS connection. If left blank, the default truststore for the Java runtime is used. This setting supports the Spring Expression Language. |
cas.monitor.endpoints.ldap.trust-store-password=
Password needed to open the truststore. This setting supports the Spring Expression Language. |
cas.monitor.endpoints.ldap.trust-store-type=
The type of trust keystore that determines which certificates or certificate authorities are trusted. Types depend on underlying java platform, typically |
cas.monitor.endpoints.ldap.use-start-tls=false
Whether TLS should be used and enabled when establishing the connection. |
cas.monitor.endpoints.ldap.validate-on-checkout=true
Whether connections should be validated when loaned out from the pool. |
cas.monitor.endpoints.ldap.validate-period=PT5M
Period at which pool should be validated. This settings supports the
|
cas.monitor.endpoints.ldap.validate-periodically=true
Whether connections should be validated periodically when the pool is idle. |
cas.monitor.endpoints.ldap.validate-timeout=PT5S
Period at which validation operations may time out. This settings supports the
|
cas.monitor.endpoints.ldap.ldap-authz.allow-multiple-results=false
Indicate whether the LDAP search query is allowed to return multiple entries. |
cas.monitor.endpoints.ldap.ldap-authz.base-dn=
Base DN to start the search. |
cas.monitor.endpoints.ldap.ldap-authz.group-attribute=
Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles. The final value is always prefixed with |
cas.monitor.endpoints.ldap.ldap-authz.group-base-dn=
Base DN to start the search looking for groups. |
cas.monitor.endpoints.ldap.ldap-authz.group-filter=
Search filter to begin looking for groups. |
cas.monitor.endpoints.ldap.ldap-authz.group-prefix=
A prefix that is prepended to the group attribute value to construct an authorized role. |
cas.monitor.endpoints.ldap.ldap-authz.role-attribute=uugid
Attribute expected to be found on the entry whose value is going to be used to construct roles. The final value is always prefixed with |
cas.monitor.endpoints.ldap.ldap-authz.role-prefix=ROLE_
Prefix for the role. |
cas.monitor.endpoints.ldap.ldap-authz.search-filter=
LDAP search filter to locate accounts. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=
The Attribute name case change. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names=
The Attribute names. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=
The Attribute value case change. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change=
The Dn case change. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=
The Add if exists. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN
The Dn attribute name. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names=
The Attribute names. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=
The Merge attribute name. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn=
The Base dn. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))
The Group filter. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes=
The Merge attributes. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute=
The Search attribute. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].search-referral.limit=10
The default referral limit. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].search-result.limit=10
The default referral limit. |
cas.monitor.endpoints.ldap.search-entry-handlers[0].type=
The type of search entry handler to choose. Available values are as follows:
|
cas.monitor.endpoints.ldap.validator.attribute-name=objectClass
Attribute name to use for the compare validator. |
cas.monitor.endpoints.ldap.validator.attribute-value=top
Attribute values to use for the compare validator. |
cas.monitor.endpoints.ldap.validator.base-dn=
Base DN to use for the search request of the search validator. |
cas.monitor.endpoints.ldap.validator.dn=
DN to compare to use for the compare validator. |
cas.monitor.endpoints.ldap.validator.scope=OBJECT
Search scope to use for the search request of the search validator. |
cas.monitor.endpoints.ldap.validator.search-filter=(objectClass=*)
Search filter to use for the search request of the search validator. |
cas.monitor.endpoints.ldap.validator.type=search
Determine the LDAP validator type. The following LDAP validators can be used to test connection health status:
|
LDAP Scriptable Search Filter
LDAP search filters can point to an external Groovy script to dynamically construct the final filter template.
The script itself may be designed as:
1
2
3
4
5
6
7
8
9
10
11
12
import org.ldaptive.*
import org.springframework.context.*
def run(Object[] args) {
def filter = (FilterTemplate) args[0]
def parameters = (Map) args[1]
def applicationContext = (ApplicationContext) args[2]
def logger = args[3]
logger.info("Configuring LDAP filter")
filter.setFilter("uid=something")
}
The following parameters are passed to the script:
| Parameter | Description |
|---|---|
filter |
FilterTemplate to be updated by the script and used for the LDAP query. |
parameters |
Map of query parameters which may be used to construct the final filter. |
applicationContext |
Reference to the Spring ApplicationContext reference. |
logger |
The object responsible for issuing log messages such as logger.info(...). |
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
cas.monitor.endpoints.jaas.login-config=
JAAS login resource file. |
cas.monitor.endpoints.jaas.login-context-name=
The login context name should coincide with a given index in the login config specified. This name is used as the index to the configuration specified in the login config property. JAASTest { org.springframework.security.authentication.jaas.TestLoginModule required; </code>; In the above example, JAASTest should be set as the context name.
|
cas.monitor.endpoints.jaas.refresh-configuration-on-startup=true
If set, a call to |
Reports back general health status of the system, produced by various monitors.
HealthComponent |
|
org.springframework.boot.actuate.health.HealthEndpoint |
Endpoint Details: health
CAS, being a Spring-Boot application at heart, includes a number of endpoints to help you monitor and manage the server when it’s pushed to production. You can choose to manage and monitor the deployment using HTTP endpoints, referred to as actuators.
In essence, actuator endpoints bring production-ready features to CAS. Monitoring a running CAS instance, gathering metrics, understanding traffic or the state of our database becomes trivial with such endpoints. The main benefit of these endpoints is that we can get production grade tools without having to actually implement these features ourselves. Actuators are mainly used to expose operational information about the running application – health, metrics, etc. These are HTTP endpoints or JMX beans to enable us to interact with it.
Actuator endpoints are presented by CAS in two categories:
- Those that are owned and defined by the CAS project.
- Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.
Note that by default the only endpoints exposed over the web
are info, status, health and configurationMetadata.
Other endpoints need to be explicitly enabled and then
exposed over the web in CAS settings in order to allow access.
To enable and expose an actuator endpoint:
1
2
3
4
5
management.endpoint.health.enabled=true
management.endpoints.web.exposure.include=health
# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.health.access=PERMIT
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
cas.monitor.endpoints.form-login-enabled=false
Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint. |
cas.monitor.endpoints.endpoint.[key].access=
Define the security access level of the endpoint. Available values are as follows:
|
cas.monitor.endpoints.endpoint.[key].required-authorities=
Required user authorities. |
cas.monitor.endpoints.endpoint.[key].required-ip-addresses=
Required ip addresses. |
cas.monitor.endpoints.endpoint.[key].required-roles=
Required user roles. |
Endpoints may be mapped to custom arbitrary endpoints. For example,
to remap the health endpoint to healthcheck,
specify the following settings:
1
management.endpoints.web.path-mapping.health=healthcheck
management.endpoint.health.cache.time-to-live=0ms
Maximum time that a response can be cached. |
management.endpoint.health.enabled=true
Whether to enable the health endpoint. |
management.endpoint.health.group=
Health endpoint groups. |
management.endpoint.health.logging.slow-indicator-threshold=10s
Threshold after which a warning will be logged for slow health indicators. |
management.endpoint.health.probes.add-additional-paths=false
Whether to make the liveness and readiness health groups available on the main server port. |
management.endpoint.health.probes.enabled=false
Whether to enable liveness and readiness probes. |
management.endpoint.health.roles=
Roles used to determine whether a user is authorized to be shown details. When empty, all authenticated users are authorized. |
management.endpoint.health.show-components=
When to show components. If not specified the 'show-details' setting will be used. |
management.endpoint.health.show-details=never
When to show full health details. |
management.endpoint.health.status.http-mapping=
Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200). |
management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN
Comma-separated list of health statuses in order of severity. |
management.endpoints.enabled-by-default=
Whether to enable or disable all endpoints by default. |
management.endpoints.jmx.domain=org.springframework.boot
Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set. |
management.endpoints.jmx.exposure.exclude=
Endpoint IDs that should be excluded or '*' for all. |
management.endpoints.jmx.exposure.include=*
Endpoint IDs that should be included or '*' for all. |
management.endpoints.jmx.static-names=
Additional static properties to append to all ObjectNames of MBeans representing Endpoints. |
management.endpoints.jmx.unique-names=
Whether unique runtime object names should be ensured. Deprecation status is |
management.endpoints.migrate-legacy-ids=false
Whether to transparently migrate legacy endpoint IDs. |
management.endpoints.web.base-path=/actuator
Base path for Web endpoints. Relative to the servlet context path (server.servlet.context-path) or WebFlux base path (spring.webflux.base-path) when the management server is sharing the main server port. Relative to the management server base path (management.server.base-path) when a separate management server port (management.server.port) is configured. |
management.endpoints.web.cors.allow-credentials=
Whether credentials are supported. When not set, credentials are not supported. |
management.endpoints.web.cors.allowed-headers=
Comma-separated list of headers to allow in a request. '*' allows all headers. |
management.endpoints.web.cors.allowed-methods=
Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET. |
management.endpoints.web.cors.allowed-origin-patterns=
Comma-separated list of origin patterns to allow. Unlike allowed origins which only supports '*', origin patterns are more flexible (for example 'https://*.example.com') and can be used when credentials are allowed. When no allowed origin patterns or allowed origins are set, CORS support is disabled. |
management.endpoints.web.cors.allowed-origins=
Comma-separated list of origins to allow. '*' allows all origins. When credentials are allowed, '*' cannot be used and origin patterns should be configured instead. When no allowed origins or allowed origin patterns are set, CORS support is disabled. |
management.endpoints.web.cors.exposed-headers=
Comma-separated list of headers to include in a response. |
management.endpoints.web.cors.max-age=1800s
How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used. |
management.endpoints.web.discovery.enabled=true
Whether the discovery page is enabled. |
management.endpoints.web.exposure.exclude=
Endpoint IDs that should be excluded or '*' for all. |
management.endpoints.web.exposure.include=health
Endpoint IDs that should be included or '*' for all. |
management.endpoints.web.path-mapping=
Mapping between endpoint IDs and the path that should expose them. |
management.health.binders.enabled=true
Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`. |
management.health.cassandra.enabled=true
Whether to enable Cassandra health check. |
management.health.couchbase.enabled=true
Whether to enable Couchbase health check. |
management.health.couchbase.timeout=1000ms
Timeout for getting the Bucket information from the server. Deprecation status is |
management.health.db.enabled=true
Whether to enable database health check. |
management.health.db.ignore-routing-data-sources=false
Whether to ignore AbstractRoutingDataSources when creating database health indicators. |
management.health.defaults.enabled=true
Whether to enable default health indicators. |
management.health.diskspace.enabled=true
Whether to enable disk space health check. |
management.health.diskspace.path=
Path used to compute the available disk space. |
management.health.diskspace.threshold=10MB
Minimum disk space that should be available. |
management.health.elasticsearch.enabled=true
Whether to enable Elasticsearch health check. |
management.health.elasticsearch.indices=
Comma-separated index names. Deprecation status is |
management.health.elasticsearch.response-timeout=
Time to wait for a response from the cluster. Deprecation status is |
management.health.influxdb.enabled=true
Whether to enable InfluxDB health check. |
management.health.jms.enabled=true
Whether to enable JMS health check. |
management.health.ldap.enabled=true
Whether to enable LDAP health check. |
management.health.livenessstate.enabled=false
Whether to enable liveness state health check. |
management.health.mail.enabled=true
Whether to enable Mail health check. |
management.health.mongo.enabled=true
Whether to enable MongoDB health check. |
management.health.neo4j.enabled=true
Whether to enable Neo4j health check. |
management.health.ping.enabled=true
Whether to enable ping health check. |
management.health.probes.enabled=false
Whether to enable liveness and readiness probes. Deprecation status is |
management.health.rabbit.enabled=true
Whether to enable RabbitMQ health check. |
management.health.readinessstate.enabled=false
Whether to enable readiness state health check. |
management.health.redis.enabled=true
Whether to enable Redis health check. |
management.health.refresh.enabled=true
Enable the health endpoint for the refresh scope. |
management.health.solr.enabled=true
Whether to enable Solr health check. |
management.health.zookeeper.enabled=true
Enable the health endpoint for zookeeper. |
The health endpoint may also be configured to show details via the following conditions:
| URL | Description |
|---|---|
never |
Never display details of health monitors. |
always |
Always display details of health monitors. |
when-authorized |
Details are only shown to authorized users. Authorized roles can be configured using management.endpoint.health.roles. |
The results and details of the health endpoints are produced by a number of
health indicator components that may monitor different systems, such as LDAP connection
pools, database connections, etc.
1
management.health.rabbitHealthIndicator.enabled=true
spring.security.user.name=user
Default user name. |
spring.security.user.password=
Password for the default user name. |
spring.security.user.roles=
Granted roles for the default user name. |
For basic authentication, the default username is casuser. The password may be automatically generated at startup and displayed in CAS logs if it is left undefined in CAS settings. Additional sources may also be defined that would authenticate the request via JAAS, LDAP, JDBC, etc.
Once endpoints are enabled and exposed, the security of all provided endpoints is handled by the Spring Security project. Protection and access to each endpoint is controlled via CAS settings individually such that you may decide a specific security level and method of authentication for each endpoint independently.
- If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
- If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.
There is a special endpoint named defaults which serves as a shortcut that
controls the security of all endpoints, if left undefined in CAS settings.
To enable additional logging, configure the log4j configuration file to add the following levels:
1
2
3
4
5
6
7
8
<Logger name="org.pac4j" level="debug" additivity="false">
<AppenderRef ref="console" />
<AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
<AppenderRef ref="console" />
<AppenderRef ref="file" />
</Logger>
Reports back general health status of the system, produced by various monitors.
HealthComponent |
|
org.springframework.boot.actuate.health.HealthEndpoint |
Endpoint Details: health/{path}
CAS, being a Spring-Boot application at heart, includes a number of endpoints to help you monitor and manage the server when it’s pushed to production. You can choose to manage and monitor the deployment using HTTP endpoints, referred to as actuators.
In essence, actuator endpoints bring production-ready features to CAS. Monitoring a running CAS instance, gathering metrics, understanding traffic or the state of our database becomes trivial with such endpoints. The main benefit of these endpoints is that we can get production grade tools without having to actually implement these features ourselves. Actuators are mainly used to expose operational information about the running application – health, metrics, etc. These are HTTP endpoints or JMX beans to enable us to interact with it.
Actuator endpoints are presented by CAS in two categories:
- Those that are owned and defined by the CAS project.
- Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.
Note that by default the only endpoints exposed over the web
are info, status, health and configurationMetadata.
Other endpoints need to be explicitly enabled and then
exposed over the web in CAS settings in order to allow access.
To enable and expose an actuator endpoint:
1
2
3
4
5
management.endpoint.health.enabled=true
management.endpoints.web.exposure.include=health
# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.health.access=PERMIT
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
cas.monitor.endpoints.form-login-enabled=false
Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint. |
cas.monitor.endpoints.endpoint.[key].access=
Define the security access level of the endpoint. Available values are as follows:
|
cas.monitor.endpoints.endpoint.[key].required-authorities=
Required user authorities. |
cas.monitor.endpoints.endpoint.[key].required-ip-addresses=
Required ip addresses. |
cas.monitor.endpoints.endpoint.[key].required-roles=
Required user roles. |
Endpoints may be mapped to custom arbitrary endpoints. For example,
to remap the health endpoint to healthcheck,
specify the following settings:
1
management.endpoints.web.path-mapping.health=healthcheck
management.endpoint.health.cache.time-to-live=0ms
Maximum time that a response can be cached. |
management.endpoint.health.enabled=true
Whether to enable the health endpoint. |
management.endpoint.health.group=
Health endpoint groups. |
management.endpoint.health.logging.slow-indicator-threshold=10s
Threshold after which a warning will be logged for slow health indicators. |
management.endpoint.health.probes.add-additional-paths=false
Whether to make the liveness and readiness health groups available on the main server port. |
management.endpoint.health.probes.enabled=false
Whether to enable liveness and readiness probes. |
management.endpoint.health.roles=
Roles used to determine whether a user is authorized to be shown details. When empty, all authenticated users are authorized. |
management.endpoint.health.show-components=
When to show components. If not specified the 'show-details' setting will be used. |
management.endpoint.health.show-details=never
When to show full health details. |
management.endpoint.health.status.http-mapping=
Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200). |
management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN
Comma-separated list of health statuses in order of severity. |
management.endpoints.enabled-by-default=
Whether to enable or disable all endpoints by default. |
management.endpoints.jmx.domain=org.springframework.boot
Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set. |
management.endpoints.jmx.exposure.exclude=
Endpoint IDs that should be excluded or '*' for all. |
management.endpoints.jmx.exposure.include=*
Endpoint IDs that should be included or '*' for all. |
management.endpoints.jmx.static-names=
Additional static properties to append to all ObjectNames of MBeans representing Endpoints. |
management.endpoints.jmx.unique-names=
Whether unique runtime object names should be ensured. Deprecation status is |
management.endpoints.migrate-legacy-ids=false
Whether to transparently migrate legacy endpoint IDs. |
management.endpoints.web.base-path=/actuator
Base path for Web endpoints. Relative to the servlet context path (server.servlet.context-path) or WebFlux base path (spring.webflux.base-path) when the management server is sharing the main server port. Relative to the management server base path (management.server.base-path) when a separate management server port (management.server.port) is configured. |
management.endpoints.web.cors.allow-credentials=
Whether credentials are supported. When not set, credentials are not supported. |
management.endpoints.web.cors.allowed-headers=
Comma-separated list of headers to allow in a request. '*' allows all headers. |
management.endpoints.web.cors.allowed-methods=
Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET. |
management.endpoints.web.cors.allowed-origin-patterns=
Comma-separated list of origin patterns to allow. Unlike allowed origins which only supports '*', origin patterns are more flexible (for example 'https://*.example.com') and can be used when credentials are allowed. When no allowed origin patterns or allowed origins are set, CORS support is disabled. |
management.endpoints.web.cors.allowed-origins=
Comma-separated list of origins to allow. '*' allows all origins. When credentials are allowed, '*' cannot be used and origin patterns should be configured instead. When no allowed origins or allowed origin patterns are set, CORS support is disabled. |
management.endpoints.web.cors.exposed-headers=
Comma-separated list of headers to include in a response. |
management.endpoints.web.cors.max-age=1800s
How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used. |
management.endpoints.web.discovery.enabled=true
Whether the discovery page is enabled. |
management.endpoints.web.exposure.exclude=
Endpoint IDs that should be excluded or '*' for all. |
management.endpoints.web.exposure.include=health
Endpoint IDs that should be included or '*' for all. |
management.endpoints.web.path-mapping=
Mapping between endpoint IDs and the path that should expose them. |
management.health.binders.enabled=true
Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`. |
management.health.cassandra.enabled=true
Whether to enable Cassandra health check. |
management.health.couchbase.enabled=true
Whether to enable Couchbase health check. |
management.health.couchbase.timeout=1000ms
Timeout for getting the Bucket information from the server. Deprecation status is |
management.health.db.enabled=true
Whether to enable database health check. |
management.health.db.ignore-routing-data-sources=false
Whether to ignore AbstractRoutingDataSources when creating database health indicators. |
management.health.defaults.enabled=true
Whether to enable default health indicators. |
management.health.diskspace.enabled=true
Whether to enable disk space health check. |
management.health.diskspace.path=
Path used to compute the available disk space. |
management.health.diskspace.threshold=10MB
Minimum disk space that should be available. |
management.health.elasticsearch.enabled=true
Whether to enable Elasticsearch health check. |
management.health.elasticsearch.indices=
Comma-separated index names. Deprecation status is |
management.health.elasticsearch.response-timeout=
Time to wait for a response from the cluster. Deprecation status is |
management.health.influxdb.enabled=true
Whether to enable InfluxDB health check. |
management.health.jms.enabled=true
Whether to enable JMS health check. |
management.health.ldap.enabled=true
Whether to enable LDAP health check. |
management.health.livenessstate.enabled=false
Whether to enable liveness state health check. |
management.health.mail.enabled=true
Whether to enable Mail health check. |
management.health.mongo.enabled=true
Whether to enable MongoDB health check. |
management.health.neo4j.enabled=true
Whether to enable Neo4j health check. |
management.health.ping.enabled=true
Whether to enable ping health check. |
management.health.probes.enabled=false
Whether to enable liveness and readiness probes. Deprecation status is |
management.health.rabbit.enabled=true
Whether to enable RabbitMQ health check. |
management.health.readinessstate.enabled=false
Whether to enable readiness state health check. |
management.health.redis.enabled=true
Whether to enable Redis health check. |
management.health.refresh.enabled=true
Enable the health endpoint for the refresh scope. |
management.health.solr.enabled=true
Whether to enable Solr health check. |
management.health.zookeeper.enabled=true
Enable the health endpoint for zookeeper. |
The health endpoint may also be configured to show details via the following conditions:
| URL | Description |
|---|---|
never |
Never display details of health monitors. |
always |
Always display details of health monitors. |
when-authorized |
Details are only shown to authorized users. Authorized roles can be configured using management.endpoint.health.roles. |
The results and details of the health endpoints are produced by a number of
health indicator components that may monitor different systems, such as LDAP connection
pools, database connections, etc.
1
management.health.rabbitHealthIndicator.enabled=true
spring.security.user.name=user
Default user name. |
spring.security.user.password=
Password for the default user name. |
spring.security.user.roles=
Granted roles for the default user name. |
For basic authentication, the default username is casuser. The password may be automatically generated at startup and displayed in CAS logs if it is left undefined in CAS settings. Additional sources may also be defined that would authenticate the request via JAAS, LDAP, JDBC, etc.
Once endpoints are enabled and exposed, the security of all provided endpoints is handled by the Spring Security project. Protection and access to each endpoint is controlled via CAS settings individually such that you may decide a specific security level and method of authentication for each endpoint independently.
- If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
- If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.
There is a special endpoint named defaults which serves as a shortcut that
controls the security of all endpoints, if left undefined in CAS settings.
To enable additional logging, configure the log4j configuration file to add the following levels:
1
2
3
4
5
6
7
8
<Logger name="org.pac4j" level="debug" additivity="false">
<AppenderRef ref="console" />
<AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
<AppenderRef ref="console" />
<AppenderRef ref="file" />
</Logger>
Troubleshooting
To enable additional logging, configure the log4j configuration file to add the following levels:
1
2
3
4
5
6
7
8
9
10
11
...
<Logger name="org.springframework.amqp" level="debug" additivity="false">
<AppenderRef ref="console"/>
<AppenderRef ref="file"/>
</Logger>
<Logger name="com.rabbitmq" level="debug" additivity="false">
<AppenderRef ref="console"/>
<AppenderRef ref="file"/>
</Logger>
...